1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
#![allow(non_camel_case_types, non_snake_case)]

use crate::co;
use crate::decl::*;
use crate::guard::*;
use crate::kernel::{ffi, ffi_types::*, privs::*};
use crate::prelude::*;

impl_handle! { HACCESSTOKEN;
	/// Handle to an
	/// [access token](https://learn.microsoft.com/en-us/windows/win32/secgloss/a-gly).
	/// Originally just a `HANDLE`.
}

impl kernel_Haccesstoken for HACCESSTOKEN {}

/// This trait is enabled with the `kernel` feature, and provides methods for
/// [`HACCESSTOKEN`](crate::HACCESSTOKEN).
///
/// Prefer importing this trait through the prelude:
///
/// ```no_run
/// use winsafe::prelude::*;
/// ```
pub trait kernel_Haccesstoken: Handle {
	/// [`AdjustTokenPrivileges`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-adjusttokenprivileges)
	/// function.
	///
	/// # Examples
	///
	/// ```no_run
	/// use winsafe::{self as w, prelude::*, co};
	///
	/// let htoken = w::HPROCESS::GetCurrentProcess()
	///     .OpenProcessToken(co::TOKEN::ADJUST_PRIVILEGES | co::TOKEN::QUERY)?;
	///
	/// let luid = w::LookupPrivilegeValue(None, co::SE_PRIV::SHUTDOWN_NAME)?;
	///
	/// let privs = w::TOKEN_PRIVILEGES::new(&[
	///     w::LUID_AND_ATTRIBUTES::new(luid, co::SE_PRIV_ATTR::ENABLED),
	/// ])?;
	///
	/// htoken.AdjustTokenPrivileges(w::DisabPriv::Privs(&privs))?;
	/// # w::SysResult::Ok(())
	/// ```
	fn AdjustTokenPrivileges(&self, new_state: DisabPriv) -> SysResult<()> {
		bool_to_sysresult(
			unsafe {
				ffi::AdjustTokenPrivileges(
					self.ptr(),
					match new_state {
						DisabPriv::Disab => 1,
						_ => 0,
					},
					match new_state {
						DisabPriv::Privs(privs) => privs as *const _ as _,
						_ => std::ptr::null(),
					},
					0,
					std::ptr::null_mut(),
					std::ptr::null_mut(),
				)
			},
		)
	}

	/// [`CheckTokenCapability`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-checktokencapability)
	/// function.
	#[must_use]
	fn CheckTokenCapability(&self,
		capability_sid_to_check: &SID,
	) -> SysResult<bool>
	{
		let mut has_capability: BOOL = 0;
		bool_to_sysresult(
			unsafe {
				ffi::CheckTokenCapability(
					self.ptr(),
					capability_sid_to_check as *const _ as _,
					&mut has_capability,
				)
			},
		).map(|_| has_capability != 0)
	}

	/// [`CheckTokenMembership`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-checktokenmembership)
	/// function.
	#[must_use]
	fn CheckTokenMembership(&self, sid_to_check: &SID) -> SysResult<bool> {
		let mut is_member: BOOL = 0;
		bool_to_sysresult(
			unsafe {
				ffi::CheckTokenMembership(
					self.ptr(),
					sid_to_check as *const _ as _,
					&mut is_member,
				)
			},
		).map(|_| is_member != 0)
	}

	/// [`DuplicateToken`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-duplicatetoken)
	/// function.
	#[must_use]
	fn DuplicateToken(&self,
		level: co::SECURITY_IMPERSONATION,
	) -> SysResult<CloseHandleGuard<HACCESSTOKEN>>
	{
		let mut handle = HACCESSTOKEN::NULL;
		unsafe {
			bool_to_sysresult(
				ffi::DuplicateToken(
					self.ptr(),
					level.raw(),
					handle.as_mut(),
				),
			).map(|_| CloseHandleGuard::new(handle))
		}
	}

	/// [`GetCurrentProcessToken`](https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-getcurrentprocesstoken)
	/// function.
	#[must_use]
	fn GetCurrentProcessToken() -> HACCESSTOKEN {
		HACCESSTOKEN(unsafe { ffi::GetCurrentProcessToken() })
	}

	/// [`GetCurrentThreadEffectiveToken`](https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-getcurrentthreadeffectivetoken)
	/// function.
	#[must_use]
	fn GetCurrentThreadEffectiveToken() -> HACCESSTOKEN {
		HACCESSTOKEN(unsafe { ffi::GetCurrentThreadEffectiveToken() })
	}

	/// [`GetTokenInformation`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-gettokeninformation)
	/// function.
	///
	/// The returned enum variant will correspond to the passed
	/// `information_class`.
	///
	/// # Examples
	///
	/// Retrieving the `Groups` information:
	///
	/// ```no_run
	/// use winsafe::{self as w, prelude::*, co};
	///
	/// let htoken = w::HPROCESS::GetCurrentProcess()
	///     .OpenProcessToken(co::TOKEN::QUERY)?;
	///
	/// let nfo = htoken.GetTokenInformation(co::TOKEN_INFORMATION_CLASS::Groups)?;
	/// let w::TokenInfo::Groups(groups) = nfo else { panic!("never") };
	///
	/// for (idx, g) in groups.Groups().iter().enumerate() {
	///     println!("{}: {}", idx, g.Sid().unwrap());
	/// }
	/// # w::SysResult::Ok(())
	/// ```
	#[must_use]
	fn GetTokenInformation(&self,
		information_class: co::TOKEN_INFORMATION_CLASS,
	) -> SysResult<TokenInfo>
	{
		let mut num_bytes = u32::default();
		match bool_to_sysresult(
			unsafe {
				ffi::GetTokenInformation(
					self.ptr(),
					information_class.raw(),
					std::ptr::null_mut(),
					0,
					&mut num_bytes,
				)
			},
		) {
			Err(err) => match err {
				co::ERROR::INSUFFICIENT_BUFFER => {}, // all good
				err => return Err(err),
			},
			Ok(_) => return Err(co::ERROR::INVALID_PARAMETER), // should never happen
		};

		let mut buf = vec![0u8; num_bytes as usize].into_boxed_slice();

		unsafe {
			bool_to_sysresult(
				ffi::GetTokenInformation(
					self.ptr(),
					information_class.raw(),
					buf.as_mut_ptr() as _,
					num_bytes,
					&mut num_bytes,
				),
			).map(|_| {
				match information_class {
					co::TOKEN_INFORMATION_CLASS::User => TokenInfo::User(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_USER),
					),
					co::TOKEN_INFORMATION_CLASS::Groups => TokenInfo::Groups(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS),
					),
					co::TOKEN_INFORMATION_CLASS::Privileges => TokenInfo::Privileges(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_PRIVILEGES),
					),
					co::TOKEN_INFORMATION_CLASS::Owner => TokenInfo::Owner(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_OWNER),
					),
					co::TOKEN_INFORMATION_CLASS::PrimaryGroup => TokenInfo::PrimaryGroup(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_PRIMARY_GROUP),
					),
					co::TOKEN_INFORMATION_CLASS::DefaultDacl => TokenInfo::DefaultDacl(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_DEFAULT_DACL),
					),
					co::TOKEN_INFORMATION_CLASS::Source => TokenInfo::Source(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_SOURCE),
					),
					co::TOKEN_INFORMATION_CLASS::Type => TokenInfo::Type(
						Box::from_raw(Box::into_raw(buf) as *mut co::TOKEN_TYPE),
					),
					co::TOKEN_INFORMATION_CLASS::ImpersonationLevel => TokenInfo::ImpersonationLevel(
						Box::from_raw(Box::into_raw(buf) as *mut co::SECURITY_IMPERSONATION),
					),
					co::TOKEN_INFORMATION_CLASS::Statistics => TokenInfo::Statistics(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_STATISTICS),
					),
					co::TOKEN_INFORMATION_CLASS::RestrictedSids => TokenInfo::RestrictedSids(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS),
					),
					co::TOKEN_INFORMATION_CLASS::SessionId => TokenInfo::SessionId(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::GroupsAndPrivileges => TokenInfo::GroupsAndPrivileges(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS_AND_PRIVILEGES),
					),
					co::TOKEN_INFORMATION_CLASS::SandBoxInert => TokenInfo::SandBoxInert(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::Origin => TokenInfo::Origin(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_ORIGIN),
					),
					co::TOKEN_INFORMATION_CLASS::ElevationType => TokenInfo::ElevationType(
						Box::from_raw(Box::into_raw(buf) as *mut co::TOKEN_ELEVATION_TYPE),
					),
					co::TOKEN_INFORMATION_CLASS::LinkedToken => TokenInfo::LinkedToken(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_LINKED_TOKEN),
					),
					co::TOKEN_INFORMATION_CLASS::Elevation => TokenInfo::Elevation(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_ELEVATION),
					),
					co::TOKEN_INFORMATION_CLASS::HasRestrictions => TokenInfo::HasRestrictions(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::AccessInformation => TokenInfo::AccessInformation(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_ACCESS_INFORMATION),
					),
					co::TOKEN_INFORMATION_CLASS::VirtualizationAllowed => TokenInfo::VirtualizationAllowed(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::VirtualizationEnabled => TokenInfo::VirtualizationEnabled(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::IntegrityLevel => TokenInfo::IntegrityLevel(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_MANDATORY_LABEL),
					),
					co::TOKEN_INFORMATION_CLASS::UIAccess => TokenInfo::UIAccess(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::MandatoryPolicy => TokenInfo::MandatoryPolicy(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_MANDATORY_POLICY),
					),
					co::TOKEN_INFORMATION_CLASS::LogonSid => TokenInfo::LogonSid(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS),
					),
					co::TOKEN_INFORMATION_CLASS::IsAppContainer => TokenInfo::IsAppContainer(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::Capabilities => TokenInfo::Capabilities(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS),
					),
					co::TOKEN_INFORMATION_CLASS::AppContainerNumber => TokenInfo::AppContainerNumber(
						Box::from_raw(Box::into_raw(buf) as *mut u32),
					),
					co::TOKEN_INFORMATION_CLASS::DeviceClaimAttributes => TokenInfo::DeviceClaimAttributes(
						Box::from_raw(Box::into_raw(buf) as *mut CLAIM_SECURITY_ATTRIBUTES_INFORMATION),
					),
					co::TOKEN_INFORMATION_CLASS::DeviceGroups => TokenInfo::DeviceGroups(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS),
					),
					co::TOKEN_INFORMATION_CLASS::RestrictedDeviceGroups => TokenInfo::RestrictedDeviceGroups(
						Box::from_raw(Box::into_raw(buf) as *mut TOKEN_GROUPS),
					),
					_ => panic!("co::TOKEN_INFORMATION_CLASS not implemented yet: {}", information_class),
				}
			})
		}
	}

	/// [`ImpersonateLoggedOnUser`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-impersonateloggedonuser)
	/// function.
	fn ImpersonateLoggedOnUser(&self) -> SysResult<()> {
		bool_to_sysresult(unsafe { ffi::ImpersonateLoggedOnUser(self.ptr()) })
	}

	/// [`IsTokenRestricted`](https://learn.microsoft.com/en-us/windows/win32/api/securitybaseapi/nf-securitybaseapi-istokenrestricted)
	/// function.
	#[must_use]
	fn IsTokenRestricted(&self) -> SysResult<bool> {
		match unsafe { ffi::IsTokenRestricted(self.ptr()) } {
			0 => match GetLastError() {
				co::ERROR::SUCCESS => Ok(false), // actual false
				err => Err(err),
			},
			_ => Ok(true),
		}
	}
}